SureTax Returns API

POST Submit Form Instances

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This endpoint is used to submit one or more form instances for processing. This operation finalizes the forms and submits them to the relevant system or authority for review or further action. Once submitted, the forms enter the processing workflow and are no longer editable. The endpoint supports submitting multiple forms at once.

OperationId: POST Submit Form Instances

Authorization Method(s): OAuth

Verb: POST

End Point: /api/v1/Forms/SubmitFormInstances

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
Form Instances *	formInstances	array[SubmitFormInstancesData]

SubmitFormInstancesData

Display Name	Field Name	Field Type
Id	id	string

Example Request

The following is an json request for this operation.

{
  "formInstances": [
    {
      "id": "string"
    }
  ]
}

*Mandatory parameter

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
202	The API responds with this code to indicate that the data was sent successfully.
204	204 No Content If the form does not exist, the API will respond with a No Content status. Error Responses
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/SubmitFormInstances

Add Request Headers:

{
  "formInstances": [
    {
      "id": "string"
    }
  ]
}